/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.examples.java.wordcount;

import org.apache.flink.api.common.ProgramDescription;
import org.apache.flink.examples.java.wordcount.util.WordCountData;

/**
 * Same as {@link WorkCount} but implements {@link ProgramDescription} interface.
 * 
 * <p>
 * The input is a plain text file with lines separated by newline characters.
 * 
 * <p>
 * Usage: <code>WordCountProgram [&lt;text path&gt; &lt;result path&gt;]</code><br>
 * If no parameters are provided, the program is run with default data from {@link WordCountData}.
 * 
 * <p>
 * This example shows:
 * <ul>
 * <li>how to provide additional information (using {@link ProgramDescription} interface}, that can be displayed by
 * Flink clients, ie, {@link bin/flink} and WebClient</li>
 * </ul>
 * 
 */
public class WordCountMeta extends WordCount implements ProgramDescription {

	public static void main(String[] args) throws Exception {
		WordCount.main(args);
	}

	@Override
	public String getDescription() {
		return "Simple Word-Count Example\n"
				+ "Parameters: [<text path> <result path>]\n"
				+ "If no parameters are provided, the example will run with built-in default data.";
	}
}
